feat(docs): document the batch status data type - #12263
Conversation
Merge Protections🔴 3 of 7 protections blocking · waiting on 👀 reviews and ⛓️ dependency
🔴 ⛓️ Depends-On RequirementsWaiting for
This rule is failing.Requirement based on the presence of
🔴 👀 Review RequirementsWaiting for
This rule is failing.
🔴 🔎 ReviewsWaiting for
This rule is failing.
Show 4 satisfied protections🟢 🤖 Continuous Integration
🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 📕 PR description
🟢 🚦 Auto-queueWhen all merge protections are satisfied, this pull request will be queued automatically. |
There was a problem hiding this comment.
Pull request overview
Documents the merge queue batch status.code data type and ensures the docs build/CI gate catches future schema-driven anchor drift by validating both the configuration schema and the OpenAPI schema.
Changes:
- Adds a new Batch Status section to
/configuration/data-types, rendering status codes/descriptions from the synced OpenAPI schema. - Cross-references the new data type from merge queue monitoring and batch resolution docs.
- Extends the anchor validation gate (and its tests) to scan
public/api-schemas.jsonin addition to the configuration schema.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/util/dataType.test.ts | Adds API schema coverage to the data-type anchor test suite and pins the new batch-status anchor. |
| src/content/docs/merge-queue/monitoring.mdx | Links readers to the Batch Status reference from the monitoring page. |
| src/content/docs/merge-queue/batches.mdx | References batch status codes during batch failure resolution/splitting explanation. |
| src/content/docs/configuration/data-types.mdx | Adds the Batch Status section and renders the new table component. |
| src/components/Tables/BatchStatusCodes.tsx | New table component that reads status enums + descriptions from the OpenAPI schema. |
| public/api-schemas.json | Updates BatchStatus schema metadata to include x-enum-descriptions and the x-has-data-type marker. |
| integrations/validate-data-type-anchors.ts | Extends the build-time anchor validation to check both synced schemas. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
e2af176 to
5e644c7
Compare
Revision history
|
|
This pull request is part of a Mergify stack:
|
5e644c7 to
dc555d0
Compare
dc555d0 to
fad7e3e
Compare
fad7e3e to
c73d075
Compare
40c537b to
979f038
Compare
c73d075 to
4c75840
Compare
4c75840 to
f86e05f
Compare
|
A predecessor in this stack was just merged, but I couldn't auto-rebase this PR: there's a conflict that needs manual resolution. Conflict in: Resolve by rebasing this branch onto the latest base and pushing. |
A batch's `status.code` appeared on the API reference as a bare list of values with no explanation, and nowhere else in the docs. Readers seeing a status in an API response, in the CLI, or on a dashboard chip had no way to find out what it meant. Add a Batch Status section to the data-types page, rendering a table generated from the OpenAPI spec so the codes and their descriptions come from the engine rather than being hand-maintained, and cross-reference it from the monitoring and batches pages. The table goes through the shared reader added earlier, so it already handles the shapes a synced schema can arrive in — a `$ref` to a hoisted component in particular, which the engine's enum deduplication produces. Extend the anchor build gate to scan the API spec alongside the configuration schema. This is the first data type marked in the API spec, and schema syncs land as direct pushes to main, so the deploy build is the only gate they pass through. The bundled schemas are what the sync bot will deliver once the engine side merges. They carry the per-value documentation as `x-mergify-enum`, a positional array aligned with `enum` holding a description, an optional display title and a deprecation flag, and the data-type marker under its namespaced spelling. `x-enum-descriptions` is gone: that name is an established openapi-generator convention for a positional array of strings, and publishing a map under it would mislead the SDK generators customers run against our spec. Part of MRGFY-8330 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Change-Id: Ic5cd08016af10408a80c0d9f72b86dd61abc0a84
48a347c to
a05bc6a
Compare
f86e05f to
62175a1
Compare
A batch's
status.codeappeared on the API reference as a bare list ofvalues with no explanation, and nowhere else in the docs. Readers seeing
a status in an API response, in the CLI, or on a dashboard chip had no
way to find out what it meant.
Add a Batch Status section to the data-types page, rendering a table
generated from the OpenAPI spec so the codes and their descriptions come
from the engine rather than being hand-maintained, and cross-reference it
from the monitoring and batches pages. The table goes through the shared
reader added earlier, so it already handles the shapes a synced schema
can arrive in — a
$refto a hoisted component in particular, which theengine's enum deduplication produces.
Extend the anchor build gate to scan the API spec alongside the
configuration schema. This is the first data type marked in the API
spec, and schema syncs land as direct pushes to main, so the deploy
build is the only gate they pass through.
The bundled schemas are what the sync bot will deliver once the engine
side merges. They carry the per-value documentation as
x-mergify-enum,a positional array aligned with
enumholding a description, an optionaldisplay title and a deprecation flag, and the data-type marker under its
namespaced spelling.
x-enum-descriptionsis gone: that name is anestablished openapi-generator convention for a positional array of
strings, and publishing a map under it would mislead the SDK generators
customers run against our spec.
Part of MRGFY-8330
Co-Authored-By: Claude Opus 5 (1M context) noreply@anthropic.com
Depends-On: #12319